PBHGetFInfoSync

PBHGetFInfoSync
Header:	Files.h		Carbon status:	Supported

Obtains information about a file.

OSErr PBHGetFInfoSync (
    HParmBlkPtr paramBlock
);

paramBlock: A pointer to a basic HFS parameter block.

function result: A result code.

DISCUSSION

The relevant fields of the parameter block are:

ioCompletion

On input, a pointer to a completion function.
ioResult

On output, the result code of the function.
ioNamePtr

A pointer to a pathname.
ioVRefNum

On input, a volume specification.
ioFRefNum

On output, a file reference number.
ioFDirIndex

On input, an index.
ioFlAttrib

On output, the file attributes.
ioFlFndrInfo

On output, information used by the Finder.
ioDirID

On input, a directory ID; on output, a file ID.
ioFlStBlk

On ouput, the first allocation block of the data fork.
ioFlLgLen

On output, the logical end-of-file of the data fork.
ioFlPyLen

On output, the physical end-of-file of the data fork.
ioFlRStBlk

On output, the first allocation block of the resource fork.
ioFlRLgLen

On output, the logical end-of-file of the resource fork.
ioFlRPyLen

On output, the physical end-of-file of the resource fork.
ioFlCrDat

On output, the date and time of creation.
ioFlMdDat

On output, the date and time of the last modification.

If the value of ioFDirIndex is positive, the PBHGetFInfoSync function returns information about the file whose directory index is ioFDirIndex on the volume specified by ioVRefNum in the directory specified by ioDirID. You should call PBHGetFInfoSync just before PBHSetFInfoSync, so that the current information is present in the parameter block.

If a working directory reference number is specified in ioVRefNum, the File Manager returns information about the file whose directory index is ioFDirIndex in the specified directory.

If the value of ioFDirIndex is negative or 0, the PBHGetFInfoSync function returns information about the file having the name pointed to by ioNamePtr on the volume specified by ioVRefNum. If the file is open, the reference number of the first access path found is returned in ioFRefNum, and the name of the file is returned in ioNamePtr (unless ioNamePtr is NULL).

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.